My Neighbor Alice/plots

Module-level declarations

Types

struct cell

struct minting_dto

entity occupied

struct patch_cell_dto

struct patch_plot_dto

entity plot_cell

struct plot_details

plot_details_ordered_list

struct plot_details_ordered_list

plot_with_cells

struct plot_with_cells

object plots_config

Properties

LANDSCAPING_PERMIT

val LANDSCAPING_PERMIT: text = "voucher_landscaping"

val MAX_CELL_COORD: integer = 99

val WATER_HEIGHT: integer = 0

Functions

_check_cells_on_same_height

function _check_cells_on_same_height(plot_id: integer, cells: list<location>): boolean

_check_grid_access

function _check_grid_access(plot_id: integer, cells: set<location>)

function _patch_plot(plot_id: integer, area: area, patches: list<patch_cell_dto>)

function any_water(plot_id: integer, cells: set<location>): boolean

function batch_mint(plot_data: list<plot_with_cells>, chain_id: text, contract_address: byte_array)

check_cells_on_same_height

@extend(check_cells_on_same_height) function check_cells_on_same_height(griddable: instance, cells_per_height: list<list<location>>): boolean

check_grid_access

@extend(check_grid_access) function check_grid_access(griddable: instance, cells: set<location>)

function create_cells(cells_to_create: list<immutable_mirror_struct<plot_cell>>)

get_plot_details

function get_plot_details(plot_id: integer): plot_details

get_plot_details_ordered_list

function get_plot_details_ordered_list(plot_id: integer): plot_details_ordered_list

function get_theme(region: text): integer

function is_water(plot_id: integer, location: location): boolean

function mint(plot_id: integer, plot_data: plot, chain_id: text, contract_address: byte_array, area: area, cells: list<cell>)

original_id_from_id

function original_id_from_id(id: integer): byte_array

require_patch_location_gte_zero

function require_patch_location_gte_zero(location: location)

require_patch_location_within_plot_boundaries

function require_patch_location_within_plot_boundaries(plot_area: area, patch_location: location)

require_patch_not_empty

function require_patch_not_empty(patch: patch_cell_dto)

function set_cell_type(plot_id: integer, x: integer, y: integer, cell_type: integer?)

function set_height(plot_id: integer, x: integer, y: integer, height: integer?)

validate_cell_type

function validate_cell_type(cell_type: integer)

validate_height

function validate_height(height: integer)

validate_landscaping_permit

function validate_landscaping_permit(account_id: byte_array)

Queries

get_occupied_plots

@mount("plots.get_occupied_plots") query get_occupied_plots(region: text): list<integer>

get_plot_configs

@mount("plots.get_plot_configs") query get_plot_configs(): (enabled: boolean,)

get_plot_ids_by_player

@mount("plots.get_plot_ids_by_player") query get_plot_ids_by_player(username: text, take: integer, skip: integer): list<integer>

@mount("plots.get_plot_map") query get_plot_map(plot_id: integer): plot_details

get_plot_map_ordered_list

@mount("plots.get_plot_map_ordered_list") query get_plot_map_ordered_list(plot_id: integer): plot_details_ordered_list

@mount("plots.get_plot_meta") query get_plot_meta(plot_id: integer): plot_meta_dto?

Operations

@mount("plots.patch_plot") operation patch_plot(patch_plot_dto: patch_plot_dto, account_id: byte_array, auth_descriptor_id: byte_array)

patch_plot_as_admin

@mount("plots.patch_plot_as_admin") operation patch_plot_as_admin(patch_plot_dto: patch_plot_dto)

set_global_plot_parameters

@mount("plots.set_global_plot_parameters") operation set_global_plot_parameters(enabled: boolean)

@mount("plots.set_plot_name") operation set_plot_name(name: text, plot_id: integer, account_id: byte_array, auth_descriptor_id: byte_array)